Vcenter Ovf ScaleOutGroup

Vcenter Ovf ScaleOutGroup
Vcenter Ovf ScaleOutGroup

The Vcenter Ovf ScaleOutGroup schema contains information about a scale-out group.

It allows a virtual system collection to contain a set of children that are homogeneous with respect to a prototypical virtual system or virtual system collection. It shall cause the deployment function to replicate the prototype a number of times, thus allowing the number of instantiated virtual systems to be configured dynamically at deployment time.

This is based on the ovf2:ScaleOutSection.

See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy and POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter.

JSON Example
{
    "id": "string",
    "description": "string",
    "instance_count": 0,
    "minimum_instance_count": 0,
    "maximum_instance_count": 0
}
string
id
Optional

The identifier of the scale-out group.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

string
description
Optional

The description of the scale-out group.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

integer As int64 As int64
instance_count
Optional

The scaling factor to use. It defines the number of replicas of the prototypical virtual system or virtual system collection.

This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.

integer As int64 As int64
minimum_instance_count
Optional

The minimum scaling factor.

This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package. This will be 1 if there is no explicit limit.

integer As int64 As int64
maximum_instance_count
Optional

The maximum scaling factor.

This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. This will be missing or null if there is no explicit limit.